home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / elecmail / nodelmng.zip / NODELMNG.DOC next >
Text File  |  1993-03-01  |  22KB  |  398 lines
  1.                  NODELMNG Version 1.02 Documentation
  2.                   NODELMNG -- The nodelist manager
  3.                              NOTICE
  4.                           Version 1.05
  5.                     Copyright (C), 1992, 1993
  6.                          Donald L. Tees
  7.  
  8.     First, a short explanation  of  what  NODELMNG  does  is  in 
  9. order.  Nodelmng is designed to allow you to completely automate 
  10. the maintenance  of  nodelists  and  nodediffs.   That  includes 
  11. maintaining    BBS   library   areas,   FILES.BBS   directories, 
  12. nodelist/nodediff merging, and the purging of obsolete files. It 
  13. also  will  create  a  batch  file to trigger a nodelist compile 
  14. whenever a nodediff arrives.
  15.  
  16.     Because NODELMNG erases old files, it is  a  good  idea  for 
  17. users  to  read  this  documentation.  You can, for example, ask 
  18. NODELMNG to erase all NODELISTs that it  finds  ...  but  it  is 
  19. doubtfull that you want to.  For those that want to dive in, the 
  20. following is a synopsis of what NODELMNG does.  You can probably 
  21. get  away  with  simply  reading that, and placing NODELMNG into 
  22. your nightly maintenance run.  A more  detailed  explanation  of 
  23. each phase follows.
  24.  
  25.     There is also a short addendum at the end  outlining  a  few 
  26. re-occuring  problems that new users seem to have.  If you are a 
  27. "wade in" type, you should at least read those paragraphs.
  28.  
  29. 1  -  Stage one of NODELMNG is to erase redundant NODELISTs from 
  30. your BBS files area.  While this may seem a silly first step, it 
  31. is done first to ensure maximum room on your hard disk.  You set 
  32. up the number of nodelists that you want to keep,  and  if  that 
  33. number  is exceeded, NODELMNG will delete the oldest.  Note that 
  34. NODELMNG uses the DATE from the directory to choose the oldest.
  35.  
  36. 2 - Stage two is to check NODELISTs against NODEDIFFs and see if 
  37. a  nodelist  merge is needed.  If it is, NODELMNG will unarchive 
  38. the nodelist and nodediff into a work area, then do  the  merge. 
  39. If the merge is successfull, the new nodelist is re-archived and 
  40. put back into your BBS files area. The program then starts  over 
  41. at  stage  one.  Note that you can start with a nodelist that is 
  42. several weeks out of date, and half a dozen nodediffs.  NODELMNG 
  43. will get everything up to date as soon as it is run.
  44.  
  45.     It  should  be  noted  that NODELMNG uses directory dates to 
  46. match nodelists to nodediffs.  When starting  to  use  NODELMNG, 
  47. the  most  recent  nodelist  MUST  be  dated  after  the correct 
  48. nodediff and before any other nodediffs.  Nodelists  created  by 
  49. NODELMNG  will  automatically be dated the same as the nodediff, 
  50. plus one minute to avoid this problem.  The DOS date is not used 
  51. on  the  new  archives.   The  distribution  package  includes a 
  52. utility (SAMEDATE.EXE) that  will  redate  a  nodelist  if  your 
  53. nodelist is dated incorrectly.
  54.    
  55.     Stages  one  and  two  will  repeat  until  the  nodelist is 
  56. current, then NODELMNG will proceed to step three.
  57.  
  58. 3 - Stage three of NODELMNG is to erase redundant NODEDIFFs from 
  59. your  BBS  files area.  You set the number of nodediffs that you 
  60. want to keep, and NODELMNG will erase any  extra  ones  starting 
  61. with the oldest calendar date.
  62.  
  63. 4  - Stage four of NODELMNG is to update your FILES.BBS files to 
  64. reflect  the  above  work.   Any  nodelist/nodediffs  that  were 
  65. unarchived  during stage two will be added to the FILES.BBS file 
  66. along with the appropriate description.  Note  that  only  files 
  67. unarchived   are  added,  as  until  they  are  unarchived,  the 
  68. description is unavailable.  Any nodelists or nodediffs that  do 
  69. not exist in the file area are removed from the FILES.BBS file.
  70.  
  71. 5  -  Stage five of NODELMNG is to write out two batch files for 
  72. your nodelist compile.  If stage two found no merge neded to  be 
  73. done, the first batch file is a no-op ... that is it consists of 
  74. the single line "@ECHO OFF". If, however, one or  more  nodelist 
  75. merges  was  done,  then  the  batch  file will have the correct 
  76. archive name and day number in it.
  77.  
  78. 6 - Lastly, NODELMNG will  place  a  fido  mail  packet  in  you 
  79. inbound  telling  you  what was done.  The packet is placed into 
  80. the inbound as a  standard  Fido  packet  so  that  it  will  be 
  81. compatable  with all BBS message formats.  In effect, you tosser 
  82. will put it into your BBS for you.
  83.  
  84. Setting up NODELMNG.
  85.  
  86.     NODELMNG is invoked  as  NODELMNG  [filename][/S][/C].   The 
  87. filename  is  a data file containing your setup, and defaults to 
  88. NODELMNG.DAT.  There is no need to name a different setup  file, 
  89. unless  you  are a member of several nets.  If that is the case, 
  90. you can  invoke  NODELMNG  several  times  during  your  nightly 
  91. maintenance run, each time with a setup file for a different set 
  92. of nodelists.
  93.  
  94.     The /C switch is used to create a new setup file, and the /S 
  95. switch  is  used  to  get  into setup mode.  To get started with 
  96. NODELMNG, place it in a directory  on  your  path,  then  change 
  97. directories  to the area you do your nightly BBS maintenance on. 
  98. Type NODELMNG/C, and the foillowing menu will appear.
  99.  
  100.     ╔═══<ESC> to exit══════════════════════════╗
  101.     ║                                          ║
  102.     ║  F1 - Write setup file and exit          ║
  103.     ║  F2 - Scrap setup file and exit          ║
  104.     ║  F3 - Setup BBS messages                 ║
  105.     ║  F4 - Nodelist purge parameters          ║
  106.     ║  F5 - Nodediff purge parameters          ║
  107.     ║  F6 - Nodelist/Nodediff merging          ║
  108.     ║  F7 - Batch file output parameters       ║
  109.     ║                                          ║
  110.     ╚══════════════════════════════════════════╝
  111.  
  112.     The  F1  and  F2 keys are self explanitory.  F2 will ask for 
  113. confirmation.  The F3 key is used to  setup  messages  for  your 
  114. BBS.  It is recogmended that you use this feature during initial 
  115. testing at least, although the default is not to post  messages. 
  116. The F3 key results in the following screen.
  117.  
  118.  
  119.     ╔═══<ESC> to exit══════════════════════════╗
  120.     ║                                          ║
  121.     ║  F1 - Write setup file and exit          ║
  122.     ║╔══════════════════════════════════════════════════════════════════╗
  123.     ║║                                                                  ║
  124.     ║║                Parameters for BBS messages                       ║
  125.     ║║                                                                  ║
  126.     ║║  F1 - Message type           Verbose (tell everything)           ║
  127.     ║║  F2 - Inbound area           C:\BINKLEY\INBOUND                  ║
  128.     ║║  F3 - Sysop name             Sysop                               ║
  129.     ╚║  F4 - Zone:Net/Node          1:9999/9999.0                       ║
  130.      ║  ESC - Exit to main menu                                         ║
  131.      ║                                                                  ║
  132.      ╚══════════════════════════════════════════════════════════════════╝
  133.  
  134.      F1  allows  you  to  choose when NODELMNG writes a message.  
  135. The choices are everytime it runs, never, and whenever an  error 
  136. occurs.   The last is the choice that I would recogmend once you 
  137. have everything set up.  Verbose is the choice during testing.
  138.  
  139.      F2 says where the message is to go, which is normally  your 
  140. mailer's  inbound directory.  Note that if you name the mailer's 
  141. OUTBOUND directory, and name a different node than your own with 
  142. the node number, you can get NODELMNG to notify you of errors at 
  143. a remote site.  (At  least  that  is  the  theory,  I  have  not 
  144. actually tried it).
  145.  
  146.      F3  and F4 allow you to set up the name and node number for 
  147. the messages.
  148.  
  149.      The  nodelist  purge parameters are setup via the main menu 
  150. F4 key.  The following is the screen that will appear.
  151.  
  152.         ╔═══════════════════════════════════════════════════════════╗
  153.     ╔═══<ESC> to exit══════════════════════════╗                    ║
  154.     ║                                          ║                    ║
  155.     ║  F1 - Write setup file and exit          ║                    ║
  156.     ║  F2 - Scrap setup file and exit          ║                    ║
  157.     ║  F3 - Setup BBS messages                 ║                    ║
  158.     ║  F4 - Nodelist purge parameters          ║════════════════════╝            ║
  159.     ║  F5 - Nodediff purge parameters          ║
  160.     ║  F6 - Nodelist/Nodediff merging          ║
  161.     ║  F7╔═════════════════════════════════════════════════════════════╗
  162.     ║    ║                                                             ║
  163.     ╚════║               Purge data for Nodelists                      ║
  164.          ║                                                             ║
  165.          ║ F1 - Do the purge?       No                                 ║
  166.          ║ F2 - Number to keep:     25                                 ║
  167.          ║ F3 - Area:               C:\MAX\FILE\FIDO                   ║
  168.          ║ F4 - Filename:           NODELIST                           ║
  169.          ║ F5 - Update files.bbs?   No                                 ║
  170.          ║ F6 - Files file name:    C:\MAX\FILE\FIDO\FILES.BBS         ║
  171.          ║ F7 - FILES.BBS title:    A Fidonet Nodelist for Day         ║
  172.          ║                 ESC - Exit to main menu                     ║
  173.          ║                                                             ║
  174.          ╚═════════════════════════════════════════════════════════════╝
  175.  
  176.     F1 allows you to enable/disable the nodelist purge. F2  sets 
  177. the number of nodelists you wish to keep on file.  F3 and F4 are 
  178. used to tell NODELMNG where the nodelists  are  kept,  and  what 
  179. they  are  called.   With the above setup, for example, NODELMNG 
  180. will assume that the files C:\MAX\FILE\FIDO\NODELIST.*  are  all 
  181. nodelists.   They  would  be counted, and if the number exceeded 
  182. 25, the oldest would be erased.
  183.  
  184.     If your FILES.BBS is to be updated during this  phase,  then 
  185. you  must enable it with the F5 key, and name the FILES.BBS file 
  186. with  the  F6  key.   The  F7  key  allows  you  to  decide  the 
  187. description that will be added to the FILES.BBS line.  Note that 
  188. the day number will be appended to the end of this line.
  189.  
  190.     For  example,  lets  say  that  NODELMNG  found   the   file 
  191. C:\MAX\FILE\FIDO\NODELIST.A55,   and   unpacked   it   to   find 
  192. NODELIST.255.  If NODELIST.A55 were not found in  the  FILES.BBS 
  193. file,  the line "NODELIST.A55 A Fido Nodelist for day 255" would 
  194. be appended to the end of the file.
  195.  
  196.     The main menu F5 key is used to update  the  nodediff  purge 
  197. parameters, and results in the following screen.
  198.  
  199.         ╔═══════════════════════════════════════════════════════════╗
  200.     ╔═══<ESC> to exit══════════════════════════╗                    ║
  201.     ║                                          ║                    ║
  202.     ║  F1 - Write setup file and exit          ║                    ║
  203.     ║  F2 - Scrap setup file and exit          ║                    ║
  204.     ║  F3 - Setup BBS messages                 ║                    ║
  205.     ║  F4 - Nodelist purge parameters          ║════════════════════╝
  206.     ║  F5 - Nodediff purge parameters          ║
  207.     ║  F6 - Nodelist/Nodediff merging          ║
  208.     ║  F7╔═════════════════════════════════════════════════════════════╗
  209.     ║    ║                                                             ║
  210.     ╚════║               Purge data for Nodediffs                      ║
  211.          ║                                                             ║
  212.          ║ F1 - Do the purge?       No                                 ║
  213.          ║ F2 - Number to keep:     25                                 ║
  214.          ║ F3 - Area:               C:\MAX\FILE\FIDO                   ║
  215.          ║ F4 - Filename:           NODEDIFF                           ║
  216.          ║ F5 - Update files.bbs?   No                                 ║
  217.          ║ F6 - Files file name:    C:\MAX\FILE\FIDO\FILES.BBS         ║
  218.          ║ F7 - FILES.BBS title:    The Fidonet nodediff for day       ║
  219.          ║                 ESC - Exit to main menu                     ║
  220.          ║                                                             ║
  221.          ╚═════════════════════════════════════════════════════════════╝
  222.  
  223.      The fields are used in the same manner as for NODELISTs.
  224.  
  225.      The  main  menu  F6 key is used to set up nodelist/nodediff 
  226. merging.  It results in the following screen.
  227.  
  228.         ╔═══════════════════════════════════════════════════════════╗
  229.     ╔═══<ESC> to exit══════════════════════════╗                    ║
  230.     ║                                          ║                    ║
  231.     ║  F1 - Write setup file and exit          ║                    ║
  232.     ║  F2 - Scrap setup file and exit          ║                    ║
  233.     ║  F3 - Setup BBS messages                 ║                    ║
  234.     ║  F4 - Nodelist purge parameters          ║════════════════════╝            ║
  235.     ║  F5 - Nodediff purge parameters          ║
  236.     ║  F6╔═════════════════════════════════════════════════════════════╗
  237.     ║  F7║                                                             ║
  238.     ║    ║          Nodelist/Nodediff merge parameters                 ║
  239.     ╚════║                                                             ║
  240.          ║ F1 - Do the merge?       No                                 ║
  241.          ║ F2 - Nodelist area       C:\MAX\FILE\FIDO                   ║
  242.          ║ F3 - Nodelist filename   NODELIST                           ║
  243.          ║ F4 - Nodediff area       C:\MAX\FILE\FIDO                   ║
  244.          ║ F5 - Nodediff filename   NODEDIFF                           ║
  245.          ║ F6 - Unpacker for *.Ann  C:\BBSPROG\PKUNPAK.EXE             ║
  246.          ║ F7 - Unpacker for *.Znn  C:\BBSPROG\PKUNZIP.EXE             ║
  247.          ║ F8 - Packer for *.Ann    C:\BBSPROG\PKPAK.EXE               ║
  248.          ║ F9 - Packer for *.Znn    C:\BBSPROG\PKZIP.EXE               ║
  249.          ║ F10 - Update files.bbs?  No                                 ║
  250.          ║ ALT F10- Files.bbs file  C:\MAX\FILE\FIDO\FILES.BBS         ║
  251.          ║                 ESC - Exit to main menu                     ║
  252.          ╚═════════════════════════════════════════════════════════════╝
  253.  
  254.      F1 is used  to  enable/disable  nodelist/nodediff  merging.  
  255. The  F2  through  F5  keys  are  used  to define the areas where 
  256. nodelists and nodediffs are  stored.   Note  that  if  you  have 
  257. already  set  up the areas for purging, you will not need to set 
  258. them up here.  This screen and the purge screens  reference  the 
  259. same  parameters,  and  changing  the  data  in  one  place will 
  260. automatically change it in the other.
  261.  
  262.      NODELMNG requires that  archived  files  are  named  eithor 
  263. *.Ann  or  *.Znn,  where  nn  is  a  two digit number.  This, of 
  264. course, generally imfers that they  are  ARCED  or  ZIPPED.   F6 
  265. through  F9  are used to set the full patch names where NODELMNG 
  266. can find programs for unarchiving files,  and  re-archiving  new 
  267. nodelists.   NODELMNG  will  re-archive using the same format as 
  268. the NODELIST used for the merge.  NODEDIFFs can be of eithor  or 
  269. of both types.
  270.   
  271.      The  F10  and  ALT  F10 key allow updating of the files BBS 
  272. area, the same as in the nodelist purge  screen.   These  fields 
  273. are  duplicates of the ones in the purge screen, so will already 
  274. be set up if you set them up there.
  275.  
  276.      Finally, the main menu F7 key is used to set up batch files 
  277. for nodelist compiles, and results in the following screen.
  278.    
  279.      ╔═══════════════════════════════════════════════════════════╗
  280.  ╔═══<ESC> to exit══════════════════════════╗                    ║
  281.  ║                                          ║                    ║
  282.  ║  F1 - Write setup file and exit          ║                    ║
  283.  ║  F2 - Scrap setup file and exit          ║                    ║
  284.  ║  F3 - Setup BBS messages                 ║                    ║
  285.  ║  F4 - Nodelist purge parameters          ║════════════════════╝
  286.  ║  F5 - Nodediff purge parameters          ║                     
  287.  ║  F6╔══════════════════════════════════════════════════════════════════╗
  288.  ║  F7║                                                                  ║
  289.  ║    ║                 Parameters for BATCH file                        ║
  290.  ╚════║                                                                  ║
  291.       ║  F1 - Output batch files?    No                                  ║
  292.       ║  F2 - Compile batch file     C:\MAX\COMPILE                      ║
  293.       ║  F3 - Output batch file one  C:\MAX\NODEL1.BAT                   ║
  294.       ║  F4 - Output batch file two  C:\MAX\NODEL2.BAT                   ║
  295.       ║  ESC - Exit to main menu                                         ║
  296.       ║                                                                  ║
  297.       ╚══════════════════════════════════════════════════════════════════╝
  298.  
  299.     The F1 key is used to enable/disable this  feature.  The  F3 
  300. key  and  the F4 key are used to name two output files.  This is 
  301. somewhat confusing, so please bear with me.
  302.  
  303.     To  do a batch compile, you need to know the day number, and 
  304. the file extension of the archived nodelist.  You are  going  to 
  305. create  a  batch  file that uses those that looks something like 
  306. the following:
  307.  
  308.                 COPY \MAX\FILE\NODELIST\NODELIST.%1
  309.                 PKUNZIP NODELIST.%1
  310.                 MYCOMPILER NODELIST.%2
  311.  
  312.      Lets say that you set up a such a batch file, and called it 
  313. COMPILE.BAT.   After  NODELIST.235  is created and archived into 
  314. NODELIST.A35, you want to invoke the DOS  command:
  315.  
  316.         COMPILE  A35 235
  317.  
  318.      NODELMNG writes THAT line into its' batch file ... at least 
  319. it does after a nodelist merge.  If NODELMNG finds that there is 
  320. no  new  nodelist, then it writes the line "@ECHO OFF" into the 
  321. first batch file, and the compile command to the second.
  322.  
  323.      The F2 key names the batch file that NODELMNG is  to  write 
  324. to.  That is the name that should be in your nightly maintenance 
  325. run immediately after NODELMNG.  The F3 key is the name  of  the 
  326. batch  file that you set up to do you compile, and the extension 
  327. and day of the new nodelist will be appended to  that  line  and 
  328. written out.
  329.  
  330.     With  the  above  setup,  there would be one of two results.  
  331. After NODELIST.A50 and NODEDIFF.A57 had been  merged  to  create 
  332. NODELIST.A57, C:\NODEL1.BAT and C:\NODEL2.BAT would both contain 
  333. the line:
  334.  
  335.                     C:\MAX\COMPILE 057 A57
  336.  
  337.     The following night, there would presumably be no work done.  
  338. C:\NODEL1.BAT   would   be   changed   to   "@ECHO  OFF",  while 
  339. C:\NODEL2.BAT would be left unchanged.
  340.  
  341.     The two batch files are used to accomodate those  that  want 
  342. to  totally  automate  their  compiles,  and  those that want to 
  343. maually compile the  nodelist.   For  those  running  completely 
  344. automatically,  just  invoke the first batch file after NODELMNG 
  345. in your nightly batch run.  For manual compiles, use the  second 
  346. batch file.
  347.  
  348. PROBLEMS:
  349.  
  350.     I have  had  three  repeated  problems  with  new  users  to 
  351. NODELMNG, and so am including a small addendum outlining them.
  352.  
  353. 1. - NODELMNG uses DATES to manage the nodelists.  If you have a 
  354. number  of  nodediffs  that are dated incorrectly, NODELMNG will 
  355. not apply them in order.  It will also not trigger  a  merge  if 
  356. the  NODELIST  is  dated after the NODEDIFF.  Once running, that 
  357. situation should never occur.  However,  if  you  have  unpacked 
  358. nodediffs  and then repacked them, you MUST check that the dates 
  359. of the new  nodediff  files  are  correct.   They  need  not  be 
  360. accurate,  but  they  MUST  be  in  the  correct order, with the 
  361. current nodelist dated between the apropriate nodediffs.
  362.  
  363. 2. - NODELMNG uses wildcards to find  nodelists  and  nodediffs.  
  364. That    is,   if   you   specify   that   your   nodelists   are 
  365. "C:\FRONTDOOR\NODELIST", then NODELMNG will look for and attempt 
  366. to manage "C:\FRONTDOOR\NODELIST.*".  
  367.  
  368.      THAT INCLUDES NODELIST.IDX !
  369.  
  370.     If  your  compiled  nodelist  is  the  same name as your raw 
  371. nodelist, then put them on different areas.  I have had a  bunch 
  372. of  users  that  keep  bugging me about NODELMNG failing, then I 
  373. find out that they have a NODELIST.DOC  and  a  NODEDIFF.HLP  in 
  374. their  nodelist  library.  NODELMNG is not bright enough to read 
  375. documentation ... it will try to unpack, merge, etc. and it will 
  376. fail.   The  same is true for compiled nodelists.  NODELMNG is a 
  377. library manager, NOT a disk manager, and it will  probably  fail 
  378. if  you ask it to manage an open disk area. Set up a library for 
  379. it to manage.
  380.  
  381. 3.  - NODELMNG uses the extension to determine archivers.  There 
  382. are only three extensions that it will recognize:
  383.  
  384.        *.Axx    - archiver one
  385.        *.Znn    - archiver two
  386.        *.nxx    - unarchived
  387.  
  388.     If you want NODELMNG to work, you must keep  your  nodelists 
  389. and  nodediffs  in  one  off  those  styles.   The archivers and 
  390. de-archivers for archiver  one  and  two  must  match.  And,  as 
  391. mentioned  in  item  two,  the  file  names  for  both  must  be 
  392. considered as reserved filenames for the library area.
  393.  
  394.       I hope you enjoy using NODELMNG.
  395.  
  396.       Donald L. Tees
  397.       1:221/192
  398.